Skip to main content

Query string parameters

ParameterDescriptionTypeIs it Mandatory to complete the field?Reference
batch_idBatch IDintegerMandatory2.16
offsetNumber of codes to skipinteger
countNumber of codes to receiveinteger

Note: you cannot exceed more than 1 year from the date of creation of the batch to receive codes.

Note: if it is problematic to get all the codes at once in one message, you can use the offset, count parameters (e.g., 1.000.000 codes were generated, to receive them in two messages: 1. "offset": 0, "count": 500.000; 2. "offset": 500.000, "count": 500.000)